Coverage Report

Created: 2024-12-19 06:34

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
D:\a\tools.proto\tools.proto\compiler\src\model\protocol.rs
Line
Count
Source
1
// Copyright (c) 2024, BlockProject 3D
2
//
3
// All rights reserved.
4
//
5
// Redistribution and use in source and binary forms, with or without modification,
6
// are permitted provided that the following conditions are met:
7
//
8
//     * Redistributions of source code must retain the above copyright notice,
9
//       this list of conditions and the following disclaimer.
10
//     * Redistributions in binary form must reproduce the above copyright notice,
11
//       this list of conditions and the following disclaimer in the documentation
12
//       and/or other materials provided with the distribution.
13
//     * Neither the name of BlockProject 3D nor the names of its contributors
14
//       may be used to endorse or promote products derived from this software
15
//       without specific prior written permission.
16
//
17
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29
use crate::model::message::Message;
30
use crate::model::structure::Structure;
31
use crate::model::typedef::Typedef;
32
use crate::model::union::Union;
33
use serde::Deserialize;
34
use std::collections::HashMap;
35
use std::fmt::{Display, Formatter};
36
37
#[derive(Clone, Debug, Deserialize)]
38
#[serde(rename_all = "snake_case")]
39
#[serde(untagged)]
40
pub enum Description {
41
    Single(String),
42
    Multi(Vec<String>),
43
}
44
45
#[derive(Copy, Clone, Debug, PartialEq, Eq, Deserialize)]
46
#[serde(rename_all = "snake_case")]
47
pub enum Endianness {
48
    Little,
49
    Big,
50
}
51
52
impl Display for Endianness {
53
736
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
54
736
        match self {
55
688
            Endianness::Little => f.write_str("little"),
56
48
            Endianness::Big => f.write_str("big"),
57
        }
58
736
    }
59
}
60
61
#[derive(Clone, Debug, Deserialize)]
62
pub struct Import {
63
    pub protocol: String,
64
    #[serde(rename = "type")]
65
    pub type_name: String,
66
}
67
68
#[derive(Clone, Debug, Deserialize)]
69
pub struct Enum {
70
    pub name: String,
71
    pub description: Option<Description>,
72
    pub variants: HashMap<String, isize>,
73
}
74
75
#[derive(Clone, Debug, Deserialize)]
76
pub struct Protocol {
77
    pub name: String,
78
    pub description: Option<Description>,
79
    pub endianness: Option<Endianness>,
80
    pub imports: Option<Vec<Import>>,
81
    pub structs: Option<Vec<Structure>>,
82
    pub messages: Option<Vec<Message>>,
83
    pub enums: Option<Vec<Enum>>,
84
    pub unions: Option<Vec<Union>>,
85
    pub types: Option<Vec<Typedef>>,
86
}